Obtains the background region for a menu.

OSStatus GetThemeMenuBackgroundRegion (
    const Rect *inMenuRect, 
    ThemeMenuType menuType, 
     region
);

inMenuRect

A pointer to a structure of type Rect. Before calling GetThemeMenuBackgroundRegion, set the rectangle to contain the entire menu, in global coordinates.

menuType

A value of type ThemeMenuType. Pass a constant specifying the type of menu (pull-down, pop-up, or hierarchical) whose background you wish to obtain; see “Theme Menu Type Constants” for descriptions of possible values.

region

A value of type RgnHandle. Pass a region handle created by your application. On return, the region is set to that of the rectangle specified in the inMenuRect parameter, that is, the menu’s background region.

function result

A result code.

DISCUSSION

The GetThemeMenuBackgroundRegion function obtains the background region that a menu occupies under the current theme.

VERSION NOTES

This function is available with Appearance Manager 1.0.1 and later.

AVAILABILITY

Supported in Carbon. Available in Mac OS 8.1 and later when Carbon 1.0.2 or later is present.

© 2000 Apple Computer, Inc. — (Last Updated 5/8/2000)